1 /*
2 * $Header: /home/cvs/jakarta-commons/betwixt/src/java/org/apache/commons/betwixt/digester/AddDefaultsRule.java,v 1.2 2002/07/08 16:51:38 jvanzyl Exp $
3 * $Revision: 1.2 $
4 * $Date: 2002/07/08 16:51:38 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>;.
59 *
60 * $Id: AddDefaultsRule.java,v 1.2 2002/07/08 16:51:38 jvanzyl Exp $
61 */
62 package org.apache.commons.betwixt.digester;
63
64 import java.beans.BeanInfo;
65 import java.beans.Introspector;
66 import java.beans.PropertyDescriptor;
67 import java.util.Set;
68
69 import org.apache.commons.betwixt.AttributeDescriptor;
70 import org.apache.commons.betwixt.ElementDescriptor;
71 import org.apache.commons.betwixt.NodeDescriptor;
72 import org.apache.commons.betwixt.XMLBeanInfo;
73 import org.apache.commons.betwixt.XMLIntrospector;
74 import org.apache.commons.betwixt.expression.Context;
75 import org.apache.commons.betwixt.expression.Updater;
76
77 import org.apache.commons.digester.Rule;
78 import org.apache.commons.digester.Digester;
79
80 import org.apache.commons.logging.Log;
81 import org.apache.commons.logging.LogFactory;
82
83 import org.xml.sax.Attributes;
84 import org.xml.sax.SAXException;
85
86 /*** <p><code>AddDefaultsRule</code> appends all the default properties
87 * to the current element.</p>
88 *
89 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
90 * @version $Revision: 1.2 $
91 */
92 public class AddDefaultsRule extends RuleSupport {
93
94 /*** Logger */
95 private static final Log log = LogFactory.getLog( AddDefaultsRule.class );
96
97
98 public AddDefaultsRule() {
99 }
100
101 // Rule interface
102 //-------------------------------------------------------------------------
103
104 /***
105 * Process the beginning of this element.
106 *
107 * @param attributes The attribute list of this element
108 */
109 public void begin(Attributes attributes) throws Exception {
110 Class beanClass = getBeanClass();
111 Set procesedProperties = getProcessedPropertyNameSet();
112 if ( beanClass != null ) {
113 try {
114 boolean attributesForPrimitives = getXMLInfoDigester().isAttributesForPrimitives();
115 BeanInfo beanInfo = Introspector.getBeanInfo( beanClass );
116 PropertyDescriptor[] descriptors = beanInfo.getPropertyDescriptors();
117 if ( descriptors != null ) {
118 for ( int i = 0, size = descriptors.length; i < size; i++ ) {
119 PropertyDescriptor descriptor = descriptors[i];
120 // have we already created a property for this
121 String name = descriptor.getName();
122 if ( procesedProperties.contains( name ) ) {
123 continue;
124 }
125 NodeDescriptor nodeDescriptor = XMLIntrospectorHelper.createDescriptor(
126 descriptor, attributesForPrimitives, getXMLIntrospector()
127 );
128 if ( nodeDescriptor != null ) {
129 addDescriptor( nodeDescriptor );
130 }
131 }
132 }
133 }
134 catch (Exception e) {
135 log.info( "Caught introspection exception", e );
136 }
137 }
138
139 // default any addProperty() methods
140 XMLIntrospectorHelper.defaultAddMethods( getXMLIntrospector(), getRootElementDescriptor(), beanClass );
141 }
142
143
144 // Implementation methods
145 //-------------------------------------------------------------------------
146 protected void addDescriptor( NodeDescriptor nodeDescriptor ) throws SAXException {
147 Object top = digester.peek();
148 if ( top instanceof XMLBeanInfo ) {
149 log.warn( "It is advisable to put an <addDefaults/> element inside an <element> tag" );
150
151 XMLBeanInfo beanInfo = (XMLBeanInfo) top;
152 // if there is already a root element descriptor then use it
153 // otherwise use this descriptor
154 if ( nodeDescriptor instanceof ElementDescriptor ) {
155 ElementDescriptor elementDescriptor = (ElementDescriptor) nodeDescriptor;
156 ElementDescriptor root = beanInfo.getElementDescriptor() ;
157 if ( root == null ) {
158 beanInfo.setElementDescriptor( elementDescriptor );
159 }
160 else {
161 root.addElementDescriptor( elementDescriptor );
162 }
163 }
164 else {
165 throw new SAXException( "the <addDefaults> element should be within an <element> tag" );
166 }
167 }
168 else if ( top instanceof ElementDescriptor ) {
169 ElementDescriptor parent = (ElementDescriptor) top;
170 if ( nodeDescriptor instanceof ElementDescriptor ) {
171 parent.addElementDescriptor( (ElementDescriptor) nodeDescriptor );
172 }
173 else {
174 parent.addAttributeDescriptor( (AttributeDescriptor) nodeDescriptor );
175 }
176 }
177 else {
178 throw new SAXException( "Invalid use of <addDefaults>. It should be nested inside <element> element" );
179 }
180 }
181
182 protected ElementDescriptor getRootElementDescriptor() {
183 Object top = digester.peek();
184 if ( top instanceof XMLBeanInfo ) {
185 XMLBeanInfo beanInfo = (XMLBeanInfo) top;
186 return beanInfo.getElementDescriptor();
187 }
188 else if ( top instanceof ElementDescriptor ) {
189 ElementDescriptor parent = (ElementDescriptor) top;
190 // XXX: could maybe walk up the parent hierarchy?
191 return parent;
192 }
193 return null;
194 }
195 }
This page was automatically generated by Maven